feat(error): display colored error labels on TTY stderr by anshul-garg27 · Pull Request #466 · googleworkspace/cli

anshul-garg27 · 2026-03-13T11:11:37Z

Closes #317.

Summary

When stderr is a TTY, error output now shows a colored label alongside the JSON:

error[api]: Not Found          ← bold red
error[validation]: missing arg ← bold yellow
hint: API not enabled...       ← bold cyan

JSON on stdout remains uncolored (machine-readable, pipe-safe)
Respects NO_COLOR env var (https://no-color.org/)
No new dependencies — uses std::io::IsTerminal + ANSI escape codes

Changes

src/error.rs: add stderr_supports_color(), colorize(), error_label() helpers
print_error_json(): print colored label to stderr before JSON
Add tests for NO_COLOR and error label content

Test plan

cargo test — 586 passed, 0 failed
cargo clippy -- -D warnings — clean
Manual: trigger an error and verify colors appear in terminal

Generated with Claude Code

gemini-code-assist · 2026-03-13T11:11:56Z

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the user experience for error reporting by introducing colored, human-readable labels to stderr output when it's an interactive terminal. This change allows users to quickly grasp the nature of an error without needing to parse the full JSON output, while ensuring that machine-readable JSON on stdout remains untouched. The solution is lightweight, relying on standard Rust libraries and ANSI escape codes, and respects common environmental variables for color preferences.

Highlights

Enhanced Error Output: Error messages displayed on TTY stderr now feature colored labels for improved readability and quick identification of error types.
Machine Readability Maintained: JSON output directed to stdout remains uncolored, ensuring machine-readability and pipe-safety are preserved.
NO_COLOR Environment Variable Support: The implementation respects the NO_COLOR environment variable, allowing users to disable colored output if preferred.
Dependency-Free Implementation: Colorization is achieved without introducing new dependencies, utilizing std::io::IsTerminal and standard ANSI escape codes.
New Helper Functions: Introduced stderr_supports_color(), colorize(), and error_label() helper functions to manage color logic and error label formatting.
Updated Error Printing: The print_error_json() function was modified to incorporate the new colored error labels on stderr.
Comprehensive Testing: Added new unit tests to verify the NO_COLOR environment variable handling and the correct content of error labels.

Changelog

src/error.rs
- Added stderr_supports_color function to detect TTY and NO_COLOR environment variable.
- Implemented colorize function to apply ANSI bold and color codes to text conditionally.
- Created error_label function to generate colored labels based on GwsError variants.
- Modified print_error_json to print the new colored error label to stderr before the JSON output.
- Updated accessNotConfigured hint messages to use the new colorize function for the "hint:" prefix and adjusted indentation.
- Introduced new test cases for colorize to verify NO_COLOR environment variable handling.
- Added tests for error_label to ensure correct variant-specific labels are generated.

Activity

All cargo test cases passed (586 passed, 0 failed).
cargo clippy -- -D warnings reported a clean build.
Manual verification of color appearance in the terminal is pending.
The pull request was generated using Claude Code.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Generative AI Prohibited Use Policy, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

changeset-bot · 2026-03-13T11:12:04Z

🦋 Changeset detected

Latest commit: 5efacf5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@googleworkspace/cli	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

gemini-code-assist

Code Review

This pull request introduces a great usability enhancement by adding colored error labels for TTY output, while correctly respecting the NO_COLOR standard and keeping machine-readable output on stdout clean. The implementation is well-structured. I have one suggestion to improve test reliability by preventing potential race conditions when tests are run in parallel.

src/error.rs

googleworkspace-bot · 2026-03-13T11:37:36Z

/gemini review

gemini-code-assist

Code Review

This pull request introduces colored error labels on stderr for TTY environments, which is a great improvement for user experience. The implementation correctly detects TTYs and respects the NO_COLOR standard. The changes also include relevant tests. I have one suggestion to make the new error summary conditional to avoid a potentially breaking change for non-interactive use cases.

src/error.rs

anshul-garg27 · 2026-03-13T16:11:17Z

Ready for review — all tests passing, Gemini feedback addressed. @jpoehnelt

googleworkspace-bot · 2026-03-13T20:33:33Z

/gemini review

Closes googleworkspace#317. When stderr is connected to a terminal, error output now includes a colored label before the JSON dump: error[api]: Not Found error[auth]: Token expired error[validation]: missing arg (yellow for non-fatal) error[discovery]: fetch failed - API, Auth, Discovery, Other errors: bold red - Validation errors: bold yellow (often user-correctable) - accessNotConfigured hint: bold cyan Respects NO_COLOR env var (https://no-color.org/). JSON output on stdout is never colored (machine-readable). No new dependencies — uses std::io::IsTerminal (stable since Rust 1.70) and raw ANSI escape codes.

Address Gemini review: the test_colorize_respects_no_color_env test modifies a global env var (NO_COLOR) which can race with parallel tests. Add serial_test::serial attribute for safe sequential execution.

googleworkspace-bot · 2026-03-13T20:34:43Z

/gemini review

gemini-code-assist

Code Review

This pull request introduces colored error labels for TTY stderr output, which is a great enhancement for user experience. The implementation correctly checks for TTY and respects the NO_COLOR environment variable. The code is clean and includes relevant tests. I have one suggestion to improve the robustness of a test case to prevent potential flakiness.

gemini-code-assist · 2026-03-13T20:34:56Z

src/error.rs

+        std::env::set_var("NO_COLOR", "1");
+        let result = colorize("hello", "31");
+        std::env::remove_var("NO_COLOR");
+        assert_eq!(result, "hello");


This test modifies a global environment variable, which can lead to flaky tests if not handled carefully. If colorize() panics, std::env::remove_var("NO_COLOR") will not be called, leaving the environment variable set for subsequent tests. Using std::panic::catch_unwind ensures that the cleanup code is executed even if the tested function panics, making the test more robust.

Suggested change

std::env::set_var("NO_COLOR", "1");

let result = colorize("hello", "31");

std::env::remove_var("NO_COLOR");

assert_eq!(result, "hello");

std::env::set_var("NO_COLOR", "1");

let result = std::panic::catch_unwind(|| colorize("hello", "31"));

std::env::remove_var("NO_COLOR");

assert_eq!(result.expect("colorize panicked"), "hello");

yeah good point, though in practice colorize() is a simple string format that won't panic. the test also runs in a single thread with serial_test so no parallel interference. catch_unwind feels like overkill here but happy to add if the maintainer wants it.

gemini-code-assist

Code Review

This pull request introduces colored error labels for TTY stderr output, which is a great enhancement for user experience. The implementation is clean, using standard library features and respecting the NO_COLOR environment variable. The changes are well-contained within the error.rs module and are accompanied by relevant tests. I have one suggestion to improve the robustness of a test that modifies environment variables.

gemini-code-assist · 2026-03-13T20:36:22Z

src/error.rs

+        std::env::set_var("NO_COLOR", "1");
+        let result = colorize("hello", "31");
+        std::env::remove_var("NO_COLOR");
+        assert_eq!(result, "hello");


This test modifies a global environment variable, which can lead to flaky tests if not handled carefully. If the call to colorize() were to panic, std::env::remove_var("NO_COLOR") would not be executed, potentially causing other tests to fail unexpectedly.

To make this test more robust, you can wrap the fallible operation in std::panic::catch_unwind. This ensures that the environment variable is cleaned up regardless of whether the tested function panics.

Suggested change

std::env::set_var("NO_COLOR", "1");

let result = colorize("hello", "31");

std::env::remove_var("NO_COLOR");

assert_eq!(result, "hello");

std::env::set_var("NO_COLOR", "1");

let result = std::panic::catch_unwind(|| colorize("hello", "31"));

std::env::remove_var("NO_COLOR");

assert_eq!(result.expect("colorize() panicked"), "hello");

same as above — colorize is trivial and won't panic, but can add the guard if preferred

…bels, auth propagation Component 1 (PR #485): Route triage 'no messages' and modelarmor error bodies to stderr so stdout stays machine-readable. Component 2 (PR #466): Add colored error[variant]: labels to stderr on TTY, respecting NO_COLOR. Replace emoji hint with colorized text. Component 3 (PR #446): Propagate auth errors as GwsError::Auth in calendar, chat, docs, drive, script, sheets helpers instead of silently proceeding unauthenticated. dry-run bypass preserved.

* fix: stderr/output hygiene rollup — diagnostics to stderr, colored labels, auth propagation Component 1 (PR #485): Route triage 'no messages' and modelarmor error bodies to stderr so stdout stays machine-readable. Component 2 (PR #466): Add colored error[variant]: labels to stderr on TTY, respecting NO_COLOR. Replace emoji hint with colorized text. Component 3 (PR #446): Propagate auth errors as GwsError::Auth in calendar, chat, docs, drive, script, sheets helpers instead of silently proceeding unauthenticated. dry-run bypass preserved. * fix: deduplicate accessNotConfigured stderr output Use if/else so that accessNotConfigured errors get the specialized hint guidance instead of redundantly printing both the generic summary and the hint. Non-accessNotConfigured Api errors and all other variants still get the generic error[variant]: summary line. * test: remove misleading model_armor_post error format test model_armor_post function. A proper integration test would require HTTP mocking (e.g. mockito/wiremock) which is out of scope for this PR. * refactor: deduplicate error printing else branches Use early return in accessNotConfigured branch so the generic eprintln! only appears once, eliminating the duplicated else blocks. * security: sanitize error messages before printing to stderr Add sanitize_for_terminal() to strip control characters (ANSI escape sequences, bell, backspace, etc.) from error messages before printing to stderr, preventing terminal escape injection from API responses. Newlines and tabs are preserved for readability. The function is pub(crate) so it can be reused by other modules that print untrusted content to stderr. * fix: sanitize all stderr error output across codebase Apply sanitize_for_terminal() to all 16 remaining eprintln sites that print unsanitized error strings to stderr. This prevents terminal escape sequence injection through error messages. Files updated: - workflows.rs (4 sites) - watch.rs (2 sites) - gmail/mod.rs (3 sites) - executor.rs (1 site) - subscribe.rs (1 site) - token_storage.rs (2 sites) - credential_store.rs (2 sites) - setup.rs (1 site) - generate_skills.rs (1 site) Also fixes clippy: map_err -> inspect_err where closure only logs. --------- Co-authored-by: jpoehnelt-bot <jpoehnelt-bot@users.noreply.github.com>

googleworkspace-bot added the area: core Core CLI parsing, commands, error handling, utilities label Mar 13, 2026

gemini-code-assist bot reviewed Mar 13, 2026

View reviewed changes

src/error.rs Show resolved Hide resolved

gemini-code-assist bot reviewed Mar 13, 2026

View reviewed changes

src/error.rs Show resolved Hide resolved

anshul-garg27 added 3 commits March 14, 2026 02:03

fix(test): add #[serial] to env-var test to prevent race conditions

3fb8e15

Address Gemini review: the test_colorize_respects_no_color_env test modifies a global env var (NO_COLOR) which can race with parallel tests. Add serial_test::serial attribute for safe sequential execution.

chore: add changeset

96ae271

anshul-garg27 force-pushed the feat/colored-tty-errors branch from 5efacf5 to 96ae271 Compare March 13, 2026 20:33

gemini-code-assist bot reviewed Mar 13, 2026

View reviewed changes

jpoehnelt mentioned this pull request Mar 17, 2026

fix: stderr/output hygiene rollup #525

Merged

jpoehnelt closed this in #525 Mar 17, 2026

Conversation

anshul-garg27 commented Mar 13, 2026

Summary

Changes

Test plan

Uh oh!

gemini-code-assist bot commented Mar 13, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

changeset-bot bot commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

googleworkspace-bot commented Mar 13, 2026

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

anshul-garg27 commented Mar 13, 2026

Uh oh!

googleworkspace-bot commented Mar 13, 2026

Uh oh!

googleworkspace-bot commented Mar 13, 2026

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Mar 13, 2026

Choose a reason for hiding this comment

Uh oh!

anshul-garg27 Mar 13, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Mar 13, 2026

Choose a reason for hiding this comment

Uh oh!

anshul-garg27 Mar 13, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

changeset-bot bot commented Mar 13, 2026 •

edited

Loading